QSTH-558: Add Workflow DLQ documentation #504
Merged
+406
−3
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sancar
approved these changes
Jul 28, 2025
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive REST API documentation for Workflow Dead Letter Queue (DLQ) management endpoints and updates existing failure handling documentation to include DLQ-related actions.
- Added documentation for four new DLQ REST endpoints: list, get, delete, and callback rerun
- Created a reusable snippet for DLQ message type definitions
- Updated failure handling guide to include manual DLQ management options
- Added navigation entries for the new endpoints in the documentation structure
Reviewed Changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| workflow/rest/dlq/list.mdx | Documents the endpoint to list and filter workflow runs in the DLQ |
| workflow/rest/dlq/get.mdx | Documents retrieving a single failed workflow run from the DLQ |
| workflow/rest/dlq/delete.mdx | Documents manually removing failed workflow runs from the DLQ |
| workflow/rest/dlq/callback.mdx | Documents rerunning failure callbacks for DLQ workflow runs |
| workflow/howto/failures.mdx | Updates failure handling guide with DLQ management options and callback details |
| mint.json | Adds navigation entries for the new DLQ endpoint documentation |
| _snippets/workflow/workflow-dlq-message-type.mdx | Defines reusable response field documentation for DLQ message structure |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added documentation for following endpoints:
Updated "Handle Failed Runs" documentation to mention DLQ actions.